IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWDate.z / RWDate

Wrap

Text File | 2002-10-03 | 28.2 KB | 727 lines

RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) NNNNaaaammmmeeee RWDate - Rogue Wave library class SSSSyyyynnnnooooppppssssiiiissss #include <rw/rwdate.h>RWDate a; // Construct today's date DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn Class RRRRWWWWDDDDaaaatttteeee represents a date, stored as a Julian day number. The member function iiiissssVVVVaaaalllliiiidddd(((()))) can be used to determine whether an RRRRWWWWDDDDaaaatttteeee is a valid date. For example, iiiissssVVVVaaaalllliiiidddd(((()))) would return FFFFAAAALLLLSSSSEEEE for the date 29 February 1991 because 1991 is not a leap year. See "Using Class RRRRWWWWDDDDaaaatttteeee" in the TTTToooooooollllssss....hhhh++++++++ UUUUsssseeeerrrr''''ssss GGGGuuuuiiiiddddeeee. RRRRWWWWDDDDaaaatttteeee's can be converted to and from RRRRWWWWTTTTiiiimmmmeeee's, and to and from the Standard C library type ssssttttrrrruuuucccctttt ttttmmmm defined in <<<<ttttiiiimmmmeeee....hhhh>>>>. Note that using a 2-digit year specifier in your code may lead to less-than-perfect behavior at the turn of the century. We urge you to create programs that are "millenially correct" by using 4-digit year specifiers. Note that because the default constructor for this class creates an instance holding the current date, constructing a large array of RRRRWWWWDDDDaaaatttteeee may be slow. RWDate v[5000]; // Figures out the current date 5000 times Those with access to the Standard C++ Library-based versions of the TTTToooooooollllssss....hhhh++++++++ template collections should consider the following: // Figures out the current date just once: RWTValOrderedVector<RWDate> v(5000, RWDate()); Thanks to the smart allocation scheme of the standard collections, the above declaration will result in only one call to the default constructor followed by 5000 invocations of the copy constructor. In the case of RRRRWWWWDDDDaaaatttteeee,,,, the copy constructor amounts to an assignment of one lllloooonnnngggg to another, resulting in faster creation than the simple array. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee PPPPaaaaggggeeee 1111 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) Simple EEEExxxxaaaammmmpppplllleeee #include <rw/rwdate.h> #include <rw/rstream.h> main(){ // Today's date RWDate d; // Last Sunday's date: RWDate lastSunday = d.previous("Sunday"); cout << d << endl << lastSunday << endl; } PPPPrrrrooooggggrrrraaaammmm oooouuuuttttppppuuuutttt:::: 03/22/91 PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss 03/17/91 RWDate(); Default constructor. Constructs an RRRRWWWWDDDDaaaatttteeee with the present date. RWDate(const RWDate&); Copy constructor. RWDate(unsigned day, unsigned year); Constructs an RRRRWWWWDDDDaaaatttteeee with a given day of the year and a given year. The member function iiiissssVVVVaaaalllliiiidddd(((()))) can be used to test whether the results are a valid date. RWDate(unsigned day, unsigned month, unsigned year); Constructs an RRRRWWWWDDDDaaaatttteeee with the given day of the month, month of the year, and year. Days should be 1-31, months should be 1-12, and the year may be specified as (for example) 1990, or 90. The member function iiiissssVVVVaaaalllliiiidddd(((()))) can be used to test whether the results are a valid date. PPPPaaaaggggeeee 2222 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RWDate(unsigned day, const char* mon, unsigned year, const RWLocale& locale = RWLocale::global()); Constructs an RRRRWWWWDDDDaaaatttteeee with the given day of the month, month and year. The locale argument is used to convert the month name. Days should be 1-31, months may be specified as (for example): January, JAN, or Jan, and the year may be specified as (for example) 1990, or 90. The member function iiiissssVVVVaaaalllliiiidddd(((()))) can be used to test whether the results are a valid date. RWDate(istream& s,const RWLocale& locale = RWLocale::global()); A full line is read, and converted to a date by the locale argument. The member function iiiissssVVVVaaaalllliiiidddd(((()))) must be used to test whether the results are a valid date. Because RRRRWWWWLLLLooooccccaaaalllleeee cannot rigorously check date input, dates created in this way should also be reconfirmed by the user. RWDate(const RWCString& str, const RWLocale& locale = RWLocale::global()); The string ssssttttrrrr is converted to a date. The member function iiiissssVVVVaaaalllliiiidddd(((()))) must be used to test whether the results are a valid date. Because RRRRWWWWLLLLooooccccaaaalllleeee cannot rigorously check date input, dates created in this way should also be reconfirmed by the user. RWDate(const RWTime& t, const RWZone& zone = RWZone::local()); Constructs an RRRRWWWWDDDDaaaatttteeee from an RRRRWWWWTTTTiiiimmmmeeee. The time zone used defaults to local. The member function iiiissssVVVVaaaalllliiiidddd(((()))) must be used to test whether the results are a valid date. RWDate(const struct tm*); Constructs an RRRRWWWWDDDDaaaatttteeee from the contents of the ssssttttrrrruuuucccctttt ttttmmmm argument members ttttmmmm____yyyyeeeeaaaarrrr, ttttmmmm____mmmmoooonnnn, and ttttmmmm____mmmmddddaaaayyyy. Note that the numbering of months and years used in ssssttttrrrruuuucccctttt ttttmmmm differs from that used for RRRRWWWWDDDDaaaatttteeee and RRRRWWWWTTTTiiiimmmmeeee operations. ssssttttrrrruuuucccctttt ttttmmmm is declared in the standard include file <<<<ttttiiiimmmmeeee....hhhh>>>>.... RWDate(unsigned long jd); Construct a date from the Julian Day number jjjjdddd. Note that it is possible to construct a valid RRRRWWWWDDDDaaaatttteeee which represents a day previous to the beginning of the Gregorian calendar for some locality. Rogue Wave doesn't know the specifics for your locality, so will not enforce an PPPPaaaaggggeeee 3333 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) arbitrary cutoff for "validity." PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrrssss RWDate& ooooppppeeeerrrraaaattttoooorrrr====(const RWDate&); Assignment operator. RWDate ooooppppeeeerrrraaaattttoooorrrr++++++++(); Prefix increment operator. Adds one day to self, then return the result. RWDate ooooppppeeeerrrraaaattttoooorrrr--------(); Prefix decrement operator. Subtracts one day from self, then returns the result. RWDate ooooppppeeeerrrraaaattttoooorrrr++++++++(int); Postfix increment operator. Adds one day to self, returning the initial value. RWDate ooooppppeeeerrrraaaattttoooorrrr--------(int); Postfix decrement operator. Subtracts one day from self, returning the initial value. RWDate& ooooppppeeeerrrraaaattttoooorrrr++++====(unsigned long s); Adds ssss days to self, returning self. RWDate& ooooppppeeeerrrraaaattttoooorrrr----====(unsigned long s); Substracts ssss days from self, returning self. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss RWCString aaaassssSSSSttttrrrriiiinnnngggg(char format = 'x', const RWLocale& = RWLocale::global()) const; PPPPaaaaggggeeee 4444 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) Returns the date as a string, formatted by the RRRRWWWWLLLLooooccccaaaalllleeee argument. Formats are as defined in the standard C library function ssssttttrrrrffffttttiiiimmmmeeee(((()))). RWCString aaaassssSSSSttttrrrriiiinnnngggg(const char* format, const RWLocale& = RWLocale::global()) const; Returns the date as a string, formatted by the RRRRWWWWLLLLooooccccaaaalllleeee argument. Formats are as defined in the standard C library function ssssttttrrrrffffttttiiiimmmmeeee(((()))). RWBoolean bbbbeeeettttwwwweeeeeeeennnn(const RWDate& a, const RWDate& b) const; Returns TTTTRRRRUUUUEEEE if this RRRRWWWWDDDDaaaatttteeee is between aaaa and bbbb, inclusive. size_t bbbbiiiinnnnaaaarrrryyyySSSSttttoooorrrreeeeSSSSiiiizzzzeeee() const; Returns the number of bytes necessary to store the object using the global function RWFile& operator<<(RWFile&, const RWDate&); int ccccoooommmmppppaaaarrrreeeeTTTToooo(const RWDate* d) const; Compares self to the RRRRWWWWDDDDaaaatttteeee pointed to by dddd and returns: 0 if self == *dddd; 1 if self > *dddd; -1 if self < *dddd. unsigned ddddaaaayyyy() const; Returns the day of the year (1-366) for this date. unsigned ddddaaaayyyyOOOOffffMMMMoooonnnntttthhhh() const; Returns the day of the month (1-31) for this date. void eeeexxxxttttrrrraaaacccctttt(struct tm*) const; PPPPaaaaggggeeee 5555 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) Returns with the ssssttttrrrruuuucccctttt ttttmmmm argument filled out completely, with the time members set to 0 and ttttmmmm____iiiissssddddsssstttt set to -1. Note that the encoding for months and days of the week used in ssssttttrrrruuuucccctttt ttttmmmm differs from that used elsewhere in RRRRWWWWDDDDaaaatttteeee. If the date is invalid, all fields are set to -1. unsigned ffffiiiirrrrssssttttDDDDaaaayyyyOOOOffffMMMMoooonnnntttthhhh() const; Returns the day of the year (1-366) corresponding to the first day of this RRRRWWWWDDDDaaaatttteeee's month and year. unsigned ffffiiiirrrrssssttttDDDDaaaayyyyOOOOffffMMMMoooonnnntttthhhh(unsigned month) const; Returns the day of the year (1-366) corresponding to the first day of the month mmmmoooonnnntttthhhh (1-12) in this RRRRWWWWDDDDaaaatttteeee's year. unsigned hhhhaaaasssshhhh() const; Returns a suitable hashing value. RWBoolean iiiissssVVVVaaaalllliiiidddd() const; Returns TTTTRRRRUUUUEEEE if this is a valid date, FFFFAAAALLLLSSSSEEEE otherwise. The following two functions are provided as a service to users who need to manipulate the date representation directly. TTTThhhheeee jjjjuuuulllliiiiaaaannnn ddddaaaayyyy nnnnuuuummmmbbbbeeeerrrr iiiissss nnnnooootttt tttthhhheeee JJJJuuuulllliiiiaaaannnn ddddaaaatttteeee!!!!. The julian day number is calculated using Algorithm 199 from CCCCoooommmmmmmmuuuunnnniiiiccccaaaattttiiiioooonnnnssss ooooffff tttthhhheeee AAAACCCCMMMM, Volume 6, No. 8, (Aug. 1963), p. 444 and is valid for any valid Gregorian date in the Gregorian calendar. The Gregorian calendar was first introduced on Sep. 14, 1752, and was adopted at various times in various places. unsigned long jjjjuuuulllliiiiaaaannnn() const; Returns the value of the julian day number..... void jjjjuuuulllliiiiaaaannnn(unsigned long j); Changes the value of the julian day number to j. PPPPaaaaggggeeee 6666 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RWBoolean lllleeeeaaaapppp() const; Returns TTTTRRRRUUUUEEEE if the year of this RRRRWWWWDDDDaaaatttteeee is a leap year. RWDate mmmmaaaaxxxx(const RWDate& t) const; Returns the later date of self or tttt. RWDate mmmmiiiinnnn(const RWDate& t) const; Returns the earlier date of self or tttt. unsigned mmmmoooonnnntttthhhh() const; Returns the month (1-12) for this date. RWCString mmmmoooonnnntttthhhhNNNNaaaammmmeeee(const RWLocale& = RWLocale::global()) const; Returns the name of the month for this date, according to the optional RRRRWWWWLLLLooooccccaaaalllleeee argument. RWDate nnnneeeexxxxtttt(unsigned dayNum) const; Returns the date of the next numbered day of the week, where MMMMoooonnnnddddaaaayyyy = 1, ..., SSSSuuuunnnnddddaaaayyyy = 7. The variable ddddaaaayyyyNNNNuuuummmm must be between 1 and 7, inclusive. RWDate nnnneeeexxxxtttt(const char* dayName, const RWLocale& = RWLocale::global()) const; Returns the date of the next ddddaaaayyyyNNNNaaaammmmeeee (for example, the date of the previous Monday) The weekday name is interpreted according to the RRRRWWWWLLLLooooccccaaaalllleeee argument. RWDate pppprrrreeeevvvviiiioooouuuussss(unsigned dayNum) const; Returns the date of the previous numbered day of the week, where MMMMoooonnnnddddaaaayyyy = PPPPaaaaggggeeee 7777 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) 1, ..., SSSSuuuunnnnddddaaaayyyy = 7. The variable ddddaaaayyyyNNNNuuuummmm must be between 1 and 7, inclusive. RWDate pppprrrreeeevvvviiiioooouuuussss(const char* dayName, const RWLocale& = RWLocale::global()) const; Returns the date of the previous ddddaaaayyyyNNNNaaaammmmeeee (for example, the date of the previous Monday) The weekday name is interpreted according to the RRRRWWWWLLLLooooccccaaaalllleeee argument. RWCString wwwweeeeeeeekkkkDDDDaaaayyyyNNNNaaaammmmeeee(const RWLocale& = RWLocale::global()) const; Returns the name of the day of the week for this date, according to the optional RRRRWWWWLLLLooooccccaaaalllleeee argument. unsigned wwwweeeeeeeekkkkDDDDaaaayyyy() const; Returns the number of the day of the week for this date, where MMMMoooonnnnddddaaaayyyy = 1, ..., SSSSuuuunnnnddddaaaayyyy = 7. unsigned yyyyeeeeaaaarrrr() const; Returns the year of this date. SSSSttttaaaattttiiiicccc PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss static unsigned ddddaaaayyyyOOOOffffWWWWeeeeeeeekkkk(const char* dayName, const RWLocale& = RWLocale::global()); Returns the number of the day of the week corresponding to the given ddddaaaayyyyNNNNaaaammmmeeee. "MMMMoooonnnnddddaaaayyyy" = 1, ..., "SSSSuuuunnnnddddaaaayyyy" = 7. Names are interpreted by the RRRRWWWWLLLLooooccccaaaalllleeee argument. Returns 0 if no match is found. static unsigned ddddaaaayyyyssssIIIInnnnMMMMoooonnnntttthhhhYYYYeeeeaaaarrrr(unsigned month, unsigned year); Returns the number of days in a given month and year. Returns 0 if mmmmoooonnnntttthhhh is not between 1 and 12 inclusive. static unsigned ddddaaaayyyyssssIIIInnnnYYYYeeeeaaaarrrr(unsigned year); PPPPaaaaggggeeee 8888 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) Returns the number of days in a given year. static RWBoolean ddddaaaayyyyWWWWiiiitttthhhhiiiinnnnMMMMoooonnnntttthhhh(unsigned monthNum, unsigned dayNum, unsigned year); Returns TTTTRRRRUUUUEEEE if a day (1-31) is within a given month in a given year. static unsigned hhhhaaaasssshhhh(const RWDate& d); Returns the hash value of dddd as returned by dddd....hhhhaaaasssshhhh(((()))). static unsigned iiiinnnnddddeeeexxxxOOOOffffMMMMoooonnnntttthhhh(const char* monthName, const RWLocale& = RWLocale::global()); Returns the number of the month (1-12) corresponding to the given mmmmoooonnnntttthhhhNNNNaaaammmmeeee. Returns 0 for no match. static unsigned long jjjjddddaaaayyyy(unsigned mon, unsigned day, unsigned year); Returns the Julian day corresponding to the given month (1-12), day (1- 31) and year. Returns zero (0) if the date is invalid. static RWCString nnnnaaaammmmeeeeOOOOffffMMMMoooonnnntttthhhh(unsigned monNum, const RWLocale& = RWLocale::global()); Returns the name of month mmmmoooonnnnNNNNuuuummmm (JJJJaaaannnnuuuuaaaarrrryyyy = 1, ..., DDDDeeeecccceeeemmmmbbbbeeeerrrr = 12), formatted for the given locale. static RWBoolean lllleeeeaaaappppYYYYeeeeaaaarrrr(unsigned year); Returns TTTTRRRRUUUUEEEE if a given year is a leap year. static RWDate nnnnoooowwww(); Returns today's date. PPPPaaaaggggeeee 9999 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) static RWCString wwwweeeeeeeekkkkDDDDaaaayyyyNNNNaaaammmmeeee(unsigned dayNum, const RWLocale& = RWLocale::global()); Returns the name of the day of the week ddddaaaayyyyNNNNuuuummmm (MMMMoooonnnnddddaaaayyyy = 1, ..., SSSSuuuunnnnddddaaaayyyy = 7), formatted for the given locale. RRRReeeellllaaaatttteeeedddd GGGGlllloooobbbbaaaallll OOOOppppeeeerrrraaaattttoooorrrrssss RWBoolean ooooppppeeeerrrraaaattttoooorrrr<<<<(const RWDate& d1, const RWDate& d2); Returns TTTTRRRRUUUUEEEE if the date dddd1111 is before dddd2222. RWBoolean ooooppppeeeerrrraaaattttoooorrrr<<<<====(const RWDate& d1, const RWDate& d2); Returns TTTTRRRRUUUUEEEE if the date dddd1111 is before or the same as dddd2222. RWBoolean ooooppppeeeerrrraaaattttoooorrrr>>>>(const RWDate& d1, const RWDate& d2); Returns TTTTRRRRUUUUEEEE if the date dddd1111 is after dddd2222. RWBoolean ooooppppeeeerrrraaaattttoooorrrr>>>>====(const RWDate& d1, const RWDate& d2); Returns TTTTRRRRUUUUEEEE if the date dddd1111 is after or the same as dddd2222. RWBoolean ooooppppeeeerrrraaaattttoooorrrr========(const RWDate& d1, const RWDate& d2); Returns TTTTRRRRUUUUEEEE if the date dddd1111 is the same as tttt2222. RWBoolean ooooppppeeeerrrraaaattttoooorrrr!!!!====(const RWDate& d1, const RWDate& d2); Returns TTTTRRRRUUUUEEEE if the date dddd1111 is not the same as dddd2222. RWDate ooooppppeeeerrrraaaattttoooorrrr++++(const RWDate& d, unsigned long s); RWDate ooooppppeeeerrrraaaattttoooorrrr++++(unsigned long s, const RWDate& d); Returns the date ssss days in the future from the date dddd. PPPPaaaaggggeeee 11110000 RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) RRRRWWWWDDDDaaaatttteeee((((3333CCCC++++++++)))) unsigned long ooooppppeeeerrrraaaattttoooorrrr----(const RWDate& d1, const RWDate& d2); If d1>d2, returns the number of days between dddd1111 and dddd2222. Otherwise, the result is implementation defined. RWDate ooooppppeeeerrrraaaattttoooorrrr----(const RWDate& d, unsigned long s); Returns the date ssss days in the past from dddd. ostream& ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(ostream& s, const RWDate& d); Outputs the date dddd on oooossssttttrrrreeeeaaaammmm ssss, according to the locale imbued in the stream (see class RRRRWWWWLLLLooooccccaaaalllleeee), or by RRRRWWWWLLLLooooccccaaaalllleeee::::::::gggglllloooobbbbaaaallll(((()))) if none. istream& ooooppppeeeerrrraaaattttoooorrrr>>>>>>>>(istream& s, RWDate& t); Reads tttt from iiiissssttttrrrreeeeaaaammmm ssss. One full line is read, and the string contained is converted according to the locale imbued in the stream (see class RRRRWWWWLLLLooooccccaaaalllleeee), or by RRRRWWWWLLLLooooccccaaaalllleeee::::::::gggglllloooobbbbaaaallll(((()))) if none. The function RRRRWWWWDDDDaaaatttteeee::::::::iiiissssVVVVaaaalllliiiidddd(((()))) must be used to test whether the results are a valid date. RWvostream& ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(RWvostream&, const RWDate& date); RWFile& ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(RWFile&, const RWDate& date); Saves the date ddddaaaatttteeee to a virtual stream or RRRRWWWWFFFFiiiilllleeee, respectively. RWvistream& ooooppppeeeerrrraaaattttoooorrrr>>>>>>>>(RWvistream&, RWDate& date); RWFile& ooooppppeeeerrrraaaattttoooorrrr>>>>>>>>(RWFile&, RWDate& date); Restores the date into ddddaaaatttteeee from a virtual stream or RRRRWWWWFFFFiiiilllleeee, respectively, replacing the previous contents of ddddaaaatttteeee. PPPPaaaaggggeeee 11111111